home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Misc Servers / Zope.exe / RESOURCE.PY < prev    next >
Encoding:
Python Source  |  2000-07-12  |  16.5 KB  |  401 lines
  1. ##############################################################################
  2. # 
  3. # Zope Public License (ZPL) Version 1.0
  4. # -------------------------------------
  5. # 
  6. # Copyright (c) Digital Creations.  All rights reserved.
  7. # 
  8. # This license has been certified as Open Source(tm).
  9. # 
  10. # Redistribution and use in source and binary forms, with or without
  11. # modification, are permitted provided that the following conditions are
  12. # met:
  13. # 
  14. # 1. Redistributions in source code must retain the above copyright
  15. #    notice, this list of conditions, and the following disclaimer.
  16. # 
  17. # 2. Redistributions in binary form must reproduce the above copyright
  18. #    notice, this list of conditions, and the following disclaimer in
  19. #    the documentation and/or other materials provided with the
  20. #    distribution.
  21. # 
  22. # 3. Digital Creations requests that attribution be given to Zope
  23. #    in any manner possible. Zope includes a "Powered by Zope"
  24. #    button that is installed by default. While it is not a license
  25. #    violation to remove this button, it is requested that the
  26. #    attribution remain. A significant investment has been put
  27. #    into Zope, and this effort will continue if the Zope community
  28. #    continues to grow. This is one way to assure that growth.
  29. # 
  30. # 4. All advertising materials and documentation mentioning
  31. #    features derived from or use of this software must display
  32. #    the following acknowledgement:
  33. # 
  34. #      "This product includes software developed by Digital Creations
  35. #      for use in the Z Object Publishing Environment
  36. #      (http://www.zope.org/)."
  37. # 
  38. #    In the event that the product being advertised includes an
  39. #    intact Zope distribution (with copyright and license included)
  40. #    then this clause is waived.
  41. # 
  42. # 5. Names associated with Zope or Digital Creations must not be used to
  43. #    endorse or promote products derived from this software without
  44. #    prior written permission from Digital Creations.
  45. # 
  46. # 6. Modified redistributions of any form whatsoever must retain
  47. #    the following acknowledgment:
  48. # 
  49. #      "This product includes software developed by Digital Creations
  50. #      for use in the Z Object Publishing Environment
  51. #      (http://www.zope.org/)."
  52. # 
  53. #    Intact (re-)distributions of any official Zope release do not
  54. #    require an external acknowledgement.
  55. # 
  56. # 7. Modifications are encouraged but must be packaged separately as
  57. #    patches to official Zope releases.  Distributions that do not
  58. #    clearly separate the patches from the original work must be clearly
  59. #    labeled as unofficial distributions.  Modifications which do not
  60. #    carry the name Zope may be packaged in any form, as long as they
  61. #    conform to all of the clauses above.
  62. # 
  63. # 
  64. # Disclaimer
  65. # 
  66. #   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
  67. #   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  68. #   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  69. #   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
  70. #   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  71. #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  72. #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  73. #   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  74. #   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  75. #   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  76. #   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  77. #   SUCH DAMAGE.
  78. # 
  79. # 
  80. # This software consists of contributions made by Digital Creations and
  81. # many individuals on behalf of Digital Creations.  Specific
  82. # attributions are listed in the accompanying credits file.
  83. # 
  84. ##############################################################################
  85.  
  86. """WebDAV support - resource objects."""
  87.  
  88. __version__='$Revision: 1.32.2.1 $'[11:-2]
  89.  
  90. import sys, os, string, mimetypes, davcmds, ExtensionClass
  91. from common import absattr, aq_base, urlfix, rfc1123_date
  92. from urllib import quote, unquote
  93. import Globals, time
  94.  
  95. class Resource(ExtensionClass.Base):
  96.     """The Resource mixin class provides basic WebDAV support for
  97.     non-collection objects. It provides default implementations
  98.     for most supported WebDAV HTTP methods, however certain methods
  99.     such as PUT should be overridden to ensure correct behavior in
  100.     the context of the object type."""
  101.  
  102.     __dav_resource__=1
  103.  
  104.     __http_methods__=('GET', 'HEAD', 'POST', 'PUT', 'DELETE', 'OPTIONS',
  105.                       'TRACE', 'PROPFIND', 'PROPPATCH', 'MKCOL', 'COPY',
  106.                       'MOVE',
  107.                       )
  108.  
  109.     __ac_permissions__=(
  110.         ('View',                             ('HEAD',)),
  111.         ('Access contents information',      ('PROPFIND',)),
  112.         ('Manage properties',                ('PROPPATCH',)),
  113.         ('Delete objects',                   ('DELETE',)),
  114.     )
  115.  
  116.     def dav__init(self, request, response):
  117.         # Init expected HTTP 1.1 / WebDAV headers which are not
  118.         # currently set by the response object automagically.
  119.         # Note we set an borg-specific header for ie5 :(
  120.         response.setHeader('Connection', 'close', 1)
  121.         response.setHeader('Date', rfc1123_date(), 1)
  122.         response.setHeader('MS-Author-Via', 'DAV')
  123.  
  124.     def dav__validate(self, object, methodname, REQUEST):
  125.         msg='<strong>You are not authorized to access this resource.</strong>'
  126.         method=None
  127.         if hasattr(object, methodname):
  128.             method=getattr(object, methodname)
  129.         else:
  130.             try:    method=object.aq_acquire(methodname)
  131.             except: method=None
  132.  
  133.         if method is not None:
  134.             try: return getSecurityManager().validateValue(method)
  135.             except: pass
  136.  
  137.         raise 'Unauthorized', msg
  138.  
  139.  
  140.     # WebDAV class 1 support
  141.  
  142.     def HEAD(self, REQUEST, RESPONSE):
  143.         """Retrieve resource information without a response body."""
  144.         self.dav__init(REQUEST, RESPONSE)
  145.         
  146.         content_type=None
  147.         if hasattr(self, 'content_type'):
  148.             content_type=absattr(self.content_type)
  149.         if content_type is None:
  150.             url=urlfix(REQUEST['URL'], 'HEAD')
  151.             name=unquote(filter(None, string.split(url, '/'))[-1])
  152.             content_type, encoding=mimetypes.guess_type(name)
  153.         if content_type is None:
  154.             if hasattr(self, 'default_content_type'):
  155.                 content_type=absattr(self.default_content_type)
  156.         if content_type is None:
  157.             content_type = 'application/octet-stream'
  158.         RESPONSE.setHeader('Content-Type', string.lower(content_type))
  159.  
  160.         if hasattr(aq_base(self), 'get_size'):
  161.             RESPONSE.setHeader('Content-Length', absattr(self.get_size))
  162.         if hasattr(self, '_p_mtime'):
  163.             mtime=rfc1123_date(self._p_mtime)
  164.             RESPONSE.setHeader('Last-Modified', mtime)
  165.         RESPONSE.setStatus(200)
  166.         return RESPONSE
  167.  
  168.     def PUT(self, REQUEST, RESPONSE):
  169.         """Replace the GET response entity of an existing resource.        
  170.         Because this is often object-dependent, objects which handle
  171.         PUT should override the default PUT implementation with an
  172.         object-specific implementation. By default, PUT requests
  173.         fail with a 405 (Method Not Allowed)."""
  174.         self.dav__init(REQUEST, RESPONSE)
  175.         raise 'Method Not Allowed', 'Method not supported for this resource.'
  176.  
  177.     OPTIONS__roles__=None
  178.     def OPTIONS(self, REQUEST, RESPONSE):
  179.         """Retrieve communication options."""
  180.         self.dav__init(REQUEST, RESPONSE)
  181.         RESPONSE.setHeader('Allow', string.join(self.__http_methods__,', '))
  182.         RESPONSE.setHeader('Content-Length', 0)
  183.         RESPONSE.setHeader('DAV', '1', 1)
  184.         RESPONSE.setStatus(200)
  185.         return RESPONSE
  186.  
  187.     TRACE__roles__=None
  188.     def TRACE(self, REQUEST, RESPONSE):
  189.         """Return the HTTP message received back to the client as the
  190.         entity-body of a 200 (OK) response. This will often usually
  191.         be intercepted by the web server in use. If not, the TRACE
  192.         request will fail with a 405 (Method Not Allowed), since it
  193.         is not often possible to reproduce the HTTP request verbatim
  194.         from within the Zope environment."""
  195.         self.dav__init(REQUEST, RESPONSE)
  196.         raise 'Method Not Allowed', 'Method not supported for this resource.'
  197.  
  198.     def DELETE(self, REQUEST, RESPONSE):
  199.         """Delete a resource. For non-collection resources, DELETE may
  200.         return either 200 or 204 (No Content) to indicate success."""
  201.         self.dav__init(REQUEST, RESPONSE)
  202.         url=urlfix(REQUEST['URL'], 'DELETE')
  203.         name=unquote(filter(None, string.split(url, '/'))[-1])
  204.         # TODO: add lock checking here
  205.         self.aq_parent._delObject(name)
  206.         RESPONSE.setStatus(204)
  207.         return RESPONSE
  208.  
  209.     def PROPFIND(self, REQUEST, RESPONSE):
  210.         """Retrieve properties defined on the resource."""
  211.         self.dav__init(REQUEST, RESPONSE)
  212.         cmd=davcmds.PropFind(REQUEST)
  213.         result=cmd.apply(self)
  214.         RESPONSE.setStatus(207)
  215.         RESPONSE.setHeader('Content-Type', 'text/xml; charset="utf-8"')
  216.         RESPONSE.setBody(result)
  217.         return RESPONSE
  218.  
  219.     def PROPPATCH(self, REQUEST, RESPONSE):
  220.         """Set and/or remove properties defined on the resource."""
  221.         self.dav__init(REQUEST, RESPONSE)
  222.         if not hasattr(aq_base(self), 'propertysheets'):
  223.             raise 'Method Not Allowed', (
  224.                   'Method not supported for this resource.')
  225.         # TODO: add lock checking here
  226.         cmd=davcmds.PropPatch(REQUEST)
  227.         result=cmd.apply(self)
  228.         RESPONSE.setStatus(207)
  229.         RESPONSE.setHeader('Content-Type', 'text/xml; charset="utf-8"')
  230.         RESPONSE.setBody(result)
  231.         return RESPONSE
  232.  
  233.     def MKCOL(self, REQUEST, RESPONSE):
  234.         """Create a new collection resource. If called on an existing 
  235.         resource, MKCOL must fail with 405 (Method Not Allowed)."""
  236.         self.dav__init(REQUEST, RESPONSE)
  237.         raise 'Method Not Allowed', 'The resource already exists.'
  238.  
  239.     def COPY(self, REQUEST, RESPONSE):
  240.         """Create a duplicate of the source resource whose state
  241.         and behavior match that of the source resource as closely
  242.         as possible. Though we may later try to make a copy appear
  243.         seamless across namespaces (e.g. from Zope to Apache), COPY 
  244.         is currently only supported within the Zope namespace."""
  245.         self.dav__init(REQUEST, RESPONSE)
  246.         if not hasattr(aq_base(self), 'cb_isCopyable') or \
  247.            not self.cb_isCopyable():
  248.             raise 'Method Not Allowed', 'This object may not be copied.'
  249.         depth=REQUEST.get_header('Depth', 'infinity')
  250.         if not depth in ('0', 'infinity'):
  251.             raise 'Bad Request', 'Invalid Depth header.'
  252.         dest=REQUEST.get_header('Destination', '')
  253.         while dest and dest[-1]=='/':
  254.             dest=dest[:-1]
  255.         if not dest:
  256.             raise 'Bad Request', 'Invalid Destination header.'
  257.         oflag=string.upper(REQUEST.get_header('Overwrite', 'F'))
  258.         if not oflag in ('T', 'F'):
  259.             raise 'Bad Request', 'Invalid Overwrite header.'
  260.         path, name=os.path.split(dest)
  261.         name=unquote(name)
  262.         try: parent=REQUEST.resolve_url(path)
  263.         except ValueError:
  264.             raise 'Conflict', 'Attempt to copy to an unknown namespace.'
  265.         except 'Not Found':
  266.             raise 'Conflict', 'Object ancestors must already exist.'
  267.         except:
  268.             t, v, tb=sys.exc_info()
  269.             raise t, v
  270.         if hasattr(parent, '__null_resource__'):
  271.             raise 'Conflict', 'Object ancestors must already exist.'
  272.         existing=hasattr(aq_base(parent), name)
  273.         if existing and oflag=='F':
  274.             raise 'Precondition Failed', 'Destination resource exists.'
  275.         try: parent._checkId(name, allow_dup=1)
  276.         except: raise 'Forbidden', sys.exc_info()[1]
  277.         try: parent._verifyObjectPaste(self)
  278.         except 'Unauthorized':
  279.             raise 'Unauthorized', sys.exc_info()[1]
  280.         except: raise 'Forbidden', sys.exc_info()[1]
  281.  
  282.         ob=self._getCopy(parent)
  283.         ob.manage_afterClone(ob)
  284.         ob._setId(name)
  285.         if depth=='0' and hasattr(ob, '__dav_collection__'):
  286.             for id in ob.objectIds():
  287.                 ob._delObject(id)
  288.         if existing:
  289.             object=getattr(parent, name)
  290.             self.dav__validate(object, 'DELETE', REQUEST)
  291.             parent._delObject(name)
  292.         parent._setObject(name, ob)
  293.         #ob=ob.__of__(parent)
  294.         #ob._postCopy(parent, op=0)
  295.         RESPONSE.setStatus(existing and 204 or 201)
  296.         if not existing:
  297.             RESPONSE.setHeader('Location', dest)
  298.         RESPONSE.setBody('')
  299.         return RESPONSE
  300.  
  301.     def MOVE(self, REQUEST, RESPONSE):
  302.         """Move a resource to a new location. Though we may later try to
  303.         make a move appear seamless across namespaces (e.g. from Zope
  304.         to Apache), MOVE is currently only supported within the Zope
  305.         namespace."""
  306.         self.dav__init(REQUEST, RESPONSE)
  307.         self.dav__validate(self, 'DELETE', REQUEST)
  308.         if not hasattr(aq_base(self), 'cb_isMoveable') or \
  309.            not self.cb_isMoveable():
  310.             raise 'Method Not Allowed', 'This object may not be moved.'
  311.         dest=REQUEST.get_header('Destination', '')
  312.         while dest and dest[-1]=='/':
  313.             dest=dest[:-1]
  314.         if not dest:
  315.             raise 'Bad Request', 'No destination given'
  316.         flag=REQUEST.get_header('Overwrite', 'F')
  317.         flag=string.upper(flag)
  318.         body=REQUEST.get('BODY', '')
  319.         path, name=os.path.split(dest)
  320.         name=unquote(name)
  321.         try: parent=REQUEST.resolve_url(path)
  322.         except ValueError:
  323.             raise 'Conflict', 'Attempt to move to an unknown namespace.'
  324.         except 'Not Found':
  325.             raise 'Conflict', 'The resource %s must exist.' % path
  326.         except:
  327.             t, v, tb=sys.exc_info()
  328.             raise t, v
  329.         if hasattr(parent, '__null_resource__'):
  330.             raise 'Conflict', 'The resource %s must exist.' % path
  331.         existing=hasattr(aq_base(parent), name)
  332.         if existing and flag=='F':
  333.             raise 'Precondition Failed', 'Resource %s exists.' % dest
  334.         try: parent._checkId(name, allow_dup=1)
  335.         except: raise 'Forbidden', sys.exc_info()[1]
  336.         try: parent._verifyObjectPaste(self)
  337.         except: raise 'Forbidden', sys.exc_info()[1]
  338.  
  339.         ob=aq_base(self._getCopy(parent))
  340.         self.aq_parent._delObject(absattr(self.id))
  341.         ob._setId(name)
  342.         if existing:
  343.             object=getattr(parent, name)
  344.             self.dav__validate(object, 'DELETE', REQUEST)
  345.             parent._delObject(name)            
  346.         parent._setObject(name, ob)
  347.         #ob=ob.__of__(parent)
  348.         #ob._postCopy(parent, op=1)
  349.         RESPONSE.setStatus(existing and 204 or 201)
  350.         if not existing:
  351.             RESPONSE.setHeader('Location', dest)
  352.         RESPONSE.setBody('')
  353.         return RESPONSE
  354.  
  355.  
  356.     # WebDAV Class 2  is currently not really supported - the
  357.     # following merely fakes enough class 2 support to allow
  358.     # operation with MS O2K.
  359.  
  360.     _v_dav_lock=None
  361.  
  362.     def dav__genlocktoken(self):
  363.         return 'AA9F6414-1D77-11D3-B825-00105A989226:%.03f' % time.time()
  364.  
  365.     def LOCK(self, REQUEST, RESPONSE):
  366.         """Lock a resource"""
  367.         self.dav__init(REQUEST, RESPONSE)
  368.         token=self.dav__genlocktoken()
  369.         self._v_dav_lock=token
  370.         RESPONSE.setStatus(200)
  371.         RESPONSE.setHeader('Content-Type', 'text/xml; charset="utf-8"')
  372.         RESPONSE.setHeader('Lock-Token', '<locktoken:%s>' % token)
  373.         RESPONSE.setBody(self.fake_lock_xml % token)
  374.         return RESPONSE
  375.  
  376.     def UNLOCK(self, REQUEST, RESPONSE):
  377.         """Remove an existing lock on a resource."""
  378.         self.dav__init(REQUEST, RESPONSE)
  379.         self._v_dav_lock=None
  380.         RESPONSE.setStatus(204)
  381.         return RESPONSE
  382.  
  383.     fake_lock_xml="""<?xml version="1.0" encoding="utf-8" ?>
  384. <d:prop xmlns:d="DAV:">
  385.   <d:lockdiscovery>
  386.     <d:activelock>
  387.       <d:locktype><d:write/></d:locktype>
  388.       <d:lockscope><d:exclusive/></d:lockscope>
  389.       <d:depth>0</d:depth>
  390.       <d:owner>you</d:owner>
  391.       <d:timeout>Second-120</d:timeout>
  392.       <d:locktoken>
  393.         <d:href>locktoken:%s</d:href>
  394.       </d:locktoken>
  395.     </d:activelock>
  396.   </d:lockdiscovery>
  397. </d:prop>"""
  398.  
  399.  
  400. Globals.default__class_init__(Resource)
  401.